Improve workarea documentation
authorMatthias Clasen <mclasen@redhat.com>
Thu, 25 Sep 2014 00:34:16 +0000 (20:34 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Thu, 25 Sep 2014 00:34:16 +0000 (20:34 -0400)
Worth mentioning that workarea may not exist, and that we
return the full monitor geometry in that case.

gdk/gdkscreen.c

index cc170c5b4bc22d6d7b2aafe9c420fe4e7e991351..146e5af192b23a758cd799c215a5fe0c2ba7d510 100644 (file)
@@ -845,6 +845,10 @@ gdk_screen_get_monitor_geometry (GdkScreen    *screen,
  * similar popups, to avoid placing them below panels, docks or other
  * desktop components.
  *
+ * Note that not all backends may have a concept of workarea. This
+ * function will return the monitor geometry if a workarea is not
+ * available, or does not apply.
+ *
  * Monitor numbers start at 0. To obtain the number of monitors of
  * @screen, use gdk_screen_get_n_monitors().
  *